<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Eigen: Eigen::SparseMatrixBase&lt; Derived &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="eigendoxy.css" rel="stylesheet" type="text/css">
<!--  -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen</a>
   &#160;<span id="projectnumber">3.4.90 (git rev 67eeba6e720c5745abc77ae6c92ce0a44aa7b7ae)</span>
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.svg"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classEigen_1_1SparseMatrixBase.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="classEigen_1_1SparseMatrixBase-members.html">List of all members</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Eigen::SparseMatrixBase&lt; Derived &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__Sparse__chapter.html">Sparse linear algebra</a> &raquo; <a class="el" href="group__Sparse__Reference.html">Reference</a> &raquo; <a class="el" href="group__SparseCore__Module.html">SparseCore module</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Derived&gt;<br />
class Eigen::SparseMatrixBase&lt; Derived &gt;</h3>

<p>Base class of any sparse matrices or sparse expressions. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Derived</td><td>is the derived type, e.g. a sparse matrix type, or an expression, etc.</td></tr>
  </table>
  </dd>
</dl>
<p>This class can be extended with the help of the plugin mechanism described on the page <a class="el" href="TopicCustomizing_Plugins.html">Extending MatrixBase (and other classes)</a> by defining the preprocessor symbol <code>EIGEN_SPARSEMATRIXBASE_PLUGIN</code>. </p>
</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Eigen::SparseMatrixBase&lt; Derived &gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classEigen_1_1SparseMatrixBase__inherit__graph.png" border="0" usemap="#aEigen_1_1SparseMatrixBase_3_01Derived_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="aEigen_1_1SparseMatrixBase_3_01Derived_01_4_inherit__map" id="aEigen_1_1SparseMatrixBase_3_01Derived_01_4_inherit__map">
<area shape="rect" title="Base class of any sparse matrices or sparse expressions." alt="" coords="209,292,379,575"/>
<area shape="rect" href="classEigen_1_1SparseCompressedBase.html" title="Common base class for sparse [compressed]&#45;{row|column}&#45;storage format." alt="" coords="190,623,398,920"/>
<area shape="rect" href="structEigen_1_1EigenBase.html" title=" " alt="" coords="197,5,391,244"/>
<area shape="rect" href="classEigen_1_1SparseMapBase_3_01Derived_00_01ReadOnlyAccessors_01_4.html" title="Common base class for Map and Ref instance of sparse matrix and vector." alt="" coords="185,968,403,1309"/>
<area shape="rect" href="classEigen_1_1SparseMapBase_3_01Derived_00_01WriteAccessors_01_4.html" title="Common base class for writable Map and Ref instance of sparse matrix and vector." alt="" coords="199,1357,389,1625"/>
<area shape="rect" href="classEigen_1_1Map_3_01SparseMatrixType_01_4.html" title="Specialization of class Map for SparseMatrix&#45;like storage." alt="" coords="5,1673,183,1795"/>
<area shape="rect" href="classEigen_1_1Ref_3_01SparseMatrixType_00_01Options_01_4.html" title="A sparse matrix expression referencing an existing sparse expression." alt="" coords="207,1688,381,1780"/>
<area shape="rect" href="classEigen_1_1Ref_3_01SparseVectorType_01_4.html" title="A sparse vector expression referencing an existing sparse vector expression." alt="" coords="405,1688,580,1780"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aa87f0d5bd3103b0d3668351573ee37ca"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa456cda7b9d938e57194036a41d634604">RowsAtCompileTime</a>
, <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa27ba349f075d026c1f51d1ec69aa5b14">ColsAtCompileTime</a>
, <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caaa5022cfa2bb53129883e9b7b8abd3d68">SizeAtCompileTime</a>
, <br />
&#160;&#160;<b>MaxRowsAtCompileTime</b>
, <br />
&#160;&#160;<b>MaxColsAtCompileTime</b>
, <br />
&#160;&#160;<b>MaxSizeAtCompileTime</b>
, <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa14a3f566ed2a074beddb8aef0223bfdf">IsVectorAtCompileTime</a>
, <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa2366131ffcc38bff48a1c7572eb86dd3">NumDimensions</a>
, <br />
&#160;&#160;<a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa2af043b36fe9e08df0107cf6de496165">Flags</a>
, <br />
&#160;&#160;<b>IsRowMajor</b>
, <br />
&#160;&#160;<b>InnerSizeAtCompileTime</b>
<br />
 }</td></tr>
<tr class="separator:aa87f0d5bd3103b0d3668351573ee37ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b540ba724726ebe953f8c0df06081ed"><td class="memItemLeft" align="right" valign="top">typedef internal::traits&lt; Derived &gt;::<a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a></td></tr>
<tr class="separator:a0b540ba724726ebe953f8c0df06081ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac254d3b61718ebc2136d27bac043dcb7"><td class="memItemLeft" align="right" valign="top">typedef Scalar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#ac254d3b61718ebc2136d27bac043dcb7">value_type</a></td></tr>
<tr class="separator:ac254d3b61718ebc2136d27bac043dcb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structEigen_1_1EigenBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structEigen_1_1EigenBase')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structEigen_1_1EigenBase.html">Eigen::EigenBase&lt; Derived &gt;</a></td></tr>
<tr class="memitem:a554f30542cc2316add4b1ea0a492ff02 inherit pub_types_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="namespaceEigen.html#a62e77e0933482dafde8fe197d9a2cfde">Eigen::Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a></td></tr>
<tr class="memdesc:a554f30542cc2316add4b1ea0a492ff02 inherit pub_types_structEigen_1_1EigenBase"><td class="mdescLeft">&#160;</td><td class="mdescRight">The interface type of indices.  <a href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">More...</a><br /></td></tr>
<tr class="separator:a554f30542cc2316add4b1ea0a492ff02 inherit pub_types_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aca7ce296424ef6e478ab0fb19547a7ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">cols</a> () const</td></tr>
<tr class="separator:aca7ce296424ef6e478ab0fb19547a7ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a761bd872a06b59632fcff7b7807a77ce"><td class="memItemLeft" align="right" valign="top">const internal::eval&lt; Derived &gt;::type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a761bd872a06b59632fcff7b7807a77ce">eval</a> () const</td></tr>
<tr class="separator:a761bd872a06b59632fcff7b7807a77ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a180fcba1ccf3cdf3252a263bc1de7a1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a180fcba1ccf3cdf3252a263bc1de7a1d">innerSize</a> () const</td></tr>
<tr class="separator:a180fcba1ccf3cdf3252a263bc1de7a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7eedffa867031f649fd0fb9cc23ce4be"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a7eedffa867031f649fd0fb9cc23ce4be">isVector</a> () const</td></tr>
<tr class="separator:a7eedffa867031f649fd0fb9cc23ce4be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d4d71b3f34389e6fc01f2b86e43f7a4"><td class="memTemplParams" colspan="2">template&lt;typename OtherDerived &gt; </td></tr>
<tr class="memitem:a9d4d71b3f34389e6fc01f2b86e43f7a4"><td class="memTemplItemLeft" align="right" valign="top">const <a class="el" href="classEigen_1_1Product.html">Product</a>&lt; Derived, OtherDerived, AliasFreeProduct &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a9d4d71b3f34389e6fc01f2b86e43f7a4">operator*</a> (const <a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a>&lt; OtherDerived &gt; &amp;other) const</td></tr>
<tr class="separator:a9d4d71b3f34389e6fc01f2b86e43f7a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac86cc88a4cfef21db6b64ec0ab4c8f0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#ac86cc88a4cfef21db6b64ec0ab4c8f0a">outerSize</a> () const</td></tr>
<tr class="separator:ac86cc88a4cfef21db6b64ec0ab4c8f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8d0414b56d9d620ce9a698c1b281e5d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classEigen_1_1SparseView.html">SparseView</a>&lt; Derived &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a> (const Scalar &amp;reference=Scalar(0), const RealScalar &amp;epsilon=<a class="el" href="structEigen_1_1NumTraits.html">NumTraits</a>&lt; Scalar &gt;::dummy_precision()) const</td></tr>
<tr class="separator:ac8d0414b56d9d620ce9a698c1b281e5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1944e9fa9ce7937bfc3a87b2cb94371f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows</a> () const</td></tr>
<tr class="separator:a1944e9fa9ce7937bfc3a87b2cb94371f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a124bc57921775eb9aa2dfd9727e23472"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a124bc57921775eb9aa2dfd9727e23472">size</a> () const</td></tr>
<tr class="separator:a124bc57921775eb9aa2dfd9727e23472"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51d4898bd6a57cc3ba543a39b102423e"><td class="memItemLeft" align="right" valign="top">SparseSymmetricPermutationProduct&lt; Derived, <a class="el" href="group__enums.html#gga39e3366ff5554d731e7dc8bb642f83cdafca2ccebb604f171656deb53e8c083c1">Upper</a>|<a class="el" href="group__enums.html#gga39e3366ff5554d731e7dc8bb642f83cdaf581029282d421eee5aae14238c6f749">Lower</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SparseMatrixBase.html#a51d4898bd6a57cc3ba543a39b102423e">twistedBy</a> (const <a class="el" href="classEigen_1_1PermutationMatrix.html">PermutationMatrix</a>&lt; <a class="el" href="namespaceEigen.html#ad81fa7195215a0ce30017dfac309f0b2">Dynamic</a>, <a class="el" href="namespaceEigen.html#ad81fa7195215a0ce30017dfac309f0b2">Dynamic</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a> &gt; &amp;perm) const</td></tr>
<tr class="separator:a51d4898bd6a57cc3ba543a39b102423e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structEigen_1_1EigenBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structEigen_1_1EigenBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structEigen_1_1EigenBase.html">Eigen::EigenBase&lt; Derived &gt;</a></td></tr>
<tr class="memitem:a2d768a9877f5f69f49432d447b552bfe inherit pub_methods_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">EIGEN_CONSTEXPR <a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#a2d768a9877f5f69f49432d447b552bfe">cols</a> () const EIGEN_NOEXCEPT</td></tr>
<tr class="separator:a2d768a9877f5f69f49432d447b552bfe inherit pub_methods_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fbabe7f12bcbfba3b9a448b1f5e46fa inherit pub_methods_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#a1fbabe7f12bcbfba3b9a448b1f5e46fa">derived</a> ()</td></tr>
<tr class="separator:a1fbabe7f12bcbfba3b9a448b1f5e46fa inherit pub_methods_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd4f3f1c57b7594b96a7e30f2974ea2e inherit pub_methods_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">const Derived &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#afd4f3f1c57b7594b96a7e30f2974ea2e">derived</a> () const</td></tr>
<tr class="separator:afd4f3f1c57b7594b96a7e30f2974ea2e inherit pub_methods_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac22eb0695d00edd7d4a3b2d0a98b81c2 inherit pub_methods_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">EIGEN_CONSTEXPR <a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#ac22eb0695d00edd7d4a3b2d0a98b81c2">rows</a> () const EIGEN_NOEXCEPT</td></tr>
<tr class="separator:ac22eb0695d00edd7d4a3b2d0a98b81c2 inherit pub_methods_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae106171b6fefd3f7af108a8283de36c9 inherit pub_methods_structEigen_1_1EigenBase"><td class="memItemLeft" align="right" valign="top">EIGEN_CONSTEXPR <a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEigen_1_1EigenBase.html#ae106171b6fefd3f7af108a8283de36c9">size</a> () const EIGEN_NOEXCEPT</td></tr>
<tr class="separator:ae106171b6fefd3f7af108a8283de36c9 inherit pub_methods_structEigen_1_1EigenBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a0b540ba724726ebe953f8c0df06081ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b540ba724726ebe953f8c0df06081ed">&#9670;&nbsp;</a></span>StorageIndex</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef internal::traits&lt;Derived&gt;::<a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::<a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The integer type used to <b>store</b> indices within a <a class="el" href="classEigen_1_1SparseMatrix.html" title="A versatible sparse matrix representation.">SparseMatrix</a>. For a <code>SparseMatrix&lt;Scalar,Options,IndexType&gt;</code> it an alias of the third template parameter <code>IndexType</code>. </p>

</div>
</div>
<a id="ac254d3b61718ebc2136d27bac043dcb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac254d3b61718ebc2136d27bac043dcb7">&#9670;&nbsp;</a></span>value_type</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef Scalar <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::<a class="el" href="classEigen_1_1SparseMatrixBase.html#ac254d3b61718ebc2136d27bac043dcb7">value_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The numeric type of the expression' coefficients, e.g. float, double, int or std::complex&lt;float&gt;, etc.</p>
<p>It is an alias for the Scalar type </p>

</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aa87f0d5bd3103b0d3668351573ee37ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa87f0d5bd3103b0d3668351573ee37ca">&#9670;&nbsp;</a></span>anonymous enum</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caa456cda7b9d938e57194036a41d634604"></a>RowsAtCompileTime&#160;</td><td class="fielddoc"><p>The number of rows at compile-time. This is just a copy of the value provided by the <em>Derived</em> type. If a value is not known at compile-time, it is set to the <em>Dynamic</em> constant. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1DenseCoeffsBase_3_01Derived_00_01DirectWriteAccessors_01_4.html#ac22eb0695d00edd7d4a3b2d0a98b81c2">MatrixBase::rows()</a>, <a class="el" href="classEigen_1_1DenseCoeffsBase_3_01Derived_00_01DirectWriteAccessors_01_4.html#a2d768a9877f5f69f49432d447b552bfe">MatrixBase::cols()</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa27ba349f075d026c1f51d1ec69aa5b14">ColsAtCompileTime</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caaa5022cfa2bb53129883e9b7b8abd3d68">SizeAtCompileTime</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caa27ba349f075d026c1f51d1ec69aa5b14"></a>ColsAtCompileTime&#160;</td><td class="fielddoc"><p>The number of columns at compile-time. This is just a copy of the value provided by the <em>Derived</em> type. If a value is not known at compile-time, it is set to the <em>Dynamic</em> constant. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1DenseCoeffsBase_3_01Derived_00_01DirectWriteAccessors_01_4.html#ac22eb0695d00edd7d4a3b2d0a98b81c2">MatrixBase::rows()</a>, <a class="el" href="classEigen_1_1DenseCoeffsBase_3_01Derived_00_01DirectWriteAccessors_01_4.html#a2d768a9877f5f69f49432d447b552bfe">MatrixBase::cols()</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa456cda7b9d938e57194036a41d634604">RowsAtCompileTime</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caaa5022cfa2bb53129883e9b7b8abd3d68">SizeAtCompileTime</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caaa5022cfa2bb53129883e9b7b8abd3d68"></a>SizeAtCompileTime&#160;</td><td class="fielddoc"><p>This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to <em>Dynamic</em> if this is not known at compile-time. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa456cda7b9d938e57194036a41d634604">RowsAtCompileTime</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa27ba349f075d026c1f51d1ec69aa5b14">ColsAtCompileTime</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caa14a3f566ed2a074beddb8aef0223bfdf"></a>IsVectorAtCompileTime&#160;</td><td class="fielddoc"><p>This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row). </p>
</td></tr>
<tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caa2366131ffcc38bff48a1c7572eb86dd3"></a>NumDimensions&#160;</td><td class="fielddoc"><p>This value is equal to Tensor::NumDimensions, i.e. 0 for scalars, 1 for vectors, and 2 for matrices. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa87f0d5bd3103b0d3668351573ee37caa2af043b36fe9e08df0107cf6de496165"></a>Flags&#160;</td><td class="fielddoc"><p>This stores expression <a class="el" href="group__flags.html">Flags</a> flags which may or may not be inherited by new expressions constructed from this one. See the <a class="el" href="group__flags.html">list of flags</a>. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aca7ce296424ef6e478ab0fb19547a7ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca7ce296424ef6e478ab0fb19547a7ee">&#9670;&nbsp;</a></span>cols()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::cols </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of columns. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows()</a> </dd></dl>

</div>
</div>
<a id="a761bd872a06b59632fcff7b7807a77ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a761bd872a06b59632fcff7b7807a77ce">&#9670;&nbsp;</a></span>eval()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const internal::eval&lt;Derived&gt;::type <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::eval </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the matrix or vector obtained by evaluating this expression.</dd></dl>
<p>Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy. </p>

</div>
</div>
<a id="a180fcba1ccf3cdf3252a263bc1de7a1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a180fcba1ccf3cdf3252a263bc1de7a1d">&#9670;&nbsp;</a></span>innerSize()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::innerSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise </dd></dl>

</div>
</div>
<a id="a7eedffa867031f649fd0fb9cc23ce4be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7eedffa867031f649fd0fb9cc23ce4be">&#9670;&nbsp;</a></span>isVector()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::isVector </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if either the number of rows or the number of columns is equal to 1. In other words, this function returns <div class="fragment"><div class="line"><a class="code" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows</a>()==1 || <a class="code" href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">cols</a>()==1 </div>
<div class="ttc" id="aclassEigen_1_1SparseMatrixBase_html_a1944e9fa9ce7937bfc3a87b2cb94371f"><div class="ttname"><a href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">Eigen::SparseMatrixBase::rows</a></div><div class="ttdeci">Index rows() const</div><div class="ttdef"><b>Definition:</b> SparseMatrixBase.h:176</div></div>
<div class="ttc" id="aclassEigen_1_1SparseMatrixBase_html_aca7ce296424ef6e478ab0fb19547a7ee"><div class="ttname"><a href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">Eigen::SparseMatrixBase::cols</a></div><div class="ttdeci">Index cols() const</div><div class="ttdef"><b>Definition:</b> SparseMatrixBase.h:178</div></div>
</div><!-- fragment --> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows()</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">cols()</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aa87f0d5bd3103b0d3668351573ee37caa14a3f566ed2a074beddb8aef0223bfdf">IsVectorAtCompileTime</a>. </dd></dl>

</div>
</div>
<a id="a9d4d71b3f34389e6fc01f2b86e43f7a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4d71b3f34389e6fc01f2b86e43f7a4">&#9670;&nbsp;</a></span>operator*()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<div class="memtemplate">
template&lt;typename OtherDerived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classEigen_1_1Product.html">Product</a>&lt; Derived, OtherDerived, AliasFreeProduct &gt; <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::operator* </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a>&lt; OtherDerived &gt; &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>an expression of the product of two sparse matrices. By default a conservative product preserving the symbolic non zeros is performed. The automatic pruning of the small values can be achieved by calling the <a class="el" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned()</a> function in which case a totally different product algorithm is employed: <div class="fragment"><div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>();             <span class="comment">// suppress numerical zeros (exact)</span></div>
<div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>(ref);</div>
<div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>(ref,epsilon);</div>
<div class="ttc" id="aclassEigen_1_1SparseMatrixBase_html_ac8d0414b56d9d620ce9a698c1b281e5d"><div class="ttname"><a href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">Eigen::SparseMatrixBase::pruned</a></div><div class="ttdeci">const SparseView&lt; Derived &gt; pruned(const Scalar &amp;reference=Scalar(0), const RealScalar &amp;epsilon=NumTraits&lt; Scalar &gt;::dummy_precision()) const</div><div class="ttdef"><b>Definition:</b> SparseView.h:248</div></div>
</div><!-- fragment --> where <code>ref</code> is a meaningful non zero reference value. </dd></dl>

</div>
</div>
<a id="ac86cc88a4cfef21db6b64ec0ab4c8f0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac86cc88a4cfef21db6b64ec0ab4c8f0a">&#9670;&nbsp;</a></span>outerSize()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::outerSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise </dd></dl>

</div>
</div>
<a id="ac8d0414b56d9d620ce9a698c1b281e5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8d0414b56d9d620ce9a698c1b281e5d">&#9670;&nbsp;</a></span>pruned()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classEigen_1_1SparseView.html">SparseView</a>&lt; Derived &gt; <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::pruned </td>
          <td>(</td>
          <td class="paramtype">const Scalar &amp;&#160;</td>
          <td class="paramname"><em>reference</em> = <code>Scalar(0)</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const RealScalar &amp;&#160;</td>
          <td class="paramname"><em>epsilon</em> = <code><a class="el" href="structEigen_1_1NumTraits.html">NumTraits</a>&lt;Scalar&gt;::dummy_precision()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>an expression of <code>*this</code> with values smaller than <em>reference</em> * <em>epsilon</em> removed.</dd></dl>
<p>This method is typically used in conjunction with the product of two sparse matrices to automatically prune the smallest values as follows: </p><div class="fragment"><div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>();             <span class="comment">// suppress numerical zeros (exact)</span></div>
<div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>(ref);</div>
<div class="line">C = (A*B).<a class="code" href="classEigen_1_1SparseMatrixBase.html#ac8d0414b56d9d620ce9a698c1b281e5d">pruned</a>(ref,epsilon);</div>
</div><!-- fragment --><p> where <code>ref</code> is a meaningful non zero reference value. </p>

</div>
</div>
<a id="a1944e9fa9ce7937bfc3a87b2cb94371f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1944e9fa9ce7937bfc3a87b2cb94371f">&#9670;&nbsp;</a></span>rows()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::rows </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of rows. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">cols()</a> </dd></dl>

</div>
</div>
<a id="a124bc57921775eb9aa2dfd9727e23472"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a124bc57921775eb9aa2dfd9727e23472">&#9670;&nbsp;</a></span>size()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structEigen_1_1EigenBase.html#a554f30542cc2316add4b1ea0a492ff02">Index</a> <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of coefficients, which is <em><a class="el" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows()</a>*cols</em>(). </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classEigen_1_1SparseMatrixBase.html#a1944e9fa9ce7937bfc3a87b2cb94371f">rows()</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#aca7ce296424ef6e478ab0fb19547a7ee">cols()</a>. </dd></dl>

</div>
</div>
<a id="a51d4898bd6a57cc3ba543a39b102423e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51d4898bd6a57cc3ba543a39b102423e">&#9670;&nbsp;</a></span>twistedBy()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Derived &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SparseSymmetricPermutationProduct&lt;Derived,<a class="el" href="group__enums.html#gga39e3366ff5554d731e7dc8bb642f83cdafca2ccebb604f171656deb53e8c083c1">Upper</a>|<a class="el" href="group__enums.html#gga39e3366ff5554d731e7dc8bb642f83cdaf581029282d421eee5aae14238c6f749">Lower</a>&gt; <a class="el" href="classEigen_1_1SparseMatrixBase.html">Eigen::SparseMatrixBase</a>&lt; Derived &gt;::twistedBy </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classEigen_1_1PermutationMatrix.html">PermutationMatrix</a>&lt; <a class="el" href="namespaceEigen.html#ad81fa7195215a0ce30017dfac309f0b2">Dynamic</a>, <a class="el" href="namespaceEigen.html#ad81fa7195215a0ce30017dfac309f0b2">Dynamic</a>, <a class="el" href="classEigen_1_1SparseMatrixBase.html#a0b540ba724726ebe953f8c0df06081ed">StorageIndex</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>perm</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>an expression of P H P^-1 where H is the matrix represented by <code>*this</code> </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SparseMatrixBase_8h_source.html">SparseMatrixBase.h</a></li>
<li><a class="el" href="SparseAssign_8h_source.html">SparseAssign.h</a></li>
<li><a class="el" href="SparseCwiseBinaryOp_8h_source.html">SparseCwiseBinaryOp.h</a></li>
<li><a class="el" href="SparseCwiseUnaryOp_8h_source.html">SparseCwiseUnaryOp.h</a></li>
<li><a class="el" href="SparseDot_8h_source.html">SparseDot.h</a></li>
<li><a class="el" href="SparseFuzzy_8h_source.html">SparseFuzzy.h</a></li>
<li><a class="el" href="SparseProduct_8h_source.html">SparseProduct.h</a></li>
<li><a class="el" href="SparseRedux_8h_source.html">SparseRedux.h</a></li>
<li><a class="el" href="SparseSelfAdjointView_8h_source.html">SparseSelfAdjointView.h</a></li>
<li><a class="el" href="SparseTriangularView_8h_source.html">SparseTriangularView.h</a></li>
<li><a class="el" href="SparseView_8h_source.html">SparseView.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a></li>
    <li class="footer">Generated on Thu Apr 21 2022 13:07:56 for Eigen by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
